home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-01 / tcoop10a.zip / DOC.ZIP / CLASS.DOC next >
Text File  |  1991-11-20  |  8KB  |  198 lines
  1. ==========================================================================
  2. CLASS.DOC
  3. version 1.00   11/20/91
  4. class descriptions of TCOOP toolkit
  5. copyright (c) 1991 by James S. Clark
  6. all rights reserved
  7. ==========================================================================
  8. This document contains functional descriptions of the following classes:
  9.  
  10. CLASS NAME      BRIEF DESCRIPTION
  11. ----------      -----------------
  12. STRING          generic string class with string operators
  13.  
  14. NODE            used by List and Tree
  15. LIST            creates, sorts, and manipulates node lists
  16.  *TREE          creates, and manipulates binary trees
  17.  
  18. GRAPHIC         initializes graphics display and command handler
  19. ICON            general icon and image manipulation
  20. POINT           general point manipulation
  21.   RECT          general rectangle manipulation (uses Point)
  22.  
  23. MOUSE           Microsoft compatible mouse interface
  24. *KEYBRD         IBM BIOS keyboard interface
  25. *EVENT          device driven event processor
  26.  
  27. SOUND           background sound effect and music generator
  28.   PLAY          ASCII music encoding program
  29.     EFFECT      sound effects library and wave generator
  30.  
  31. WINDOW         text window system
  32.   MENU         pull-down menus
  33.     MENUBAR    menu bar class
  34.   CONTROL      control classes: checkbox, field, button
  35.  
  36. *ASYNC         Buffered serial communications class
  37.  
  38. ==========================================================================
  39. STRING CATEGORY
  40.  
  41. Class:    String
  42.  
  43. The String Class provides a simpler way of manipulating character arrays
  44. than is provided by C.  This includes the ability to use the + and <<
  45. operators to concatenate strings.  Over 20 methods provide control of
  46. conversion from character pointer to string and back again.  The String
  47. Class forms the basis for the C++ string operations, but does not require
  48. any other classes to function, nor do any other of the classes rely upon
  49. it.
  50.  
  51. --------------------------------------------------------------------------
  52. LIST CATEGORY
  53.  
  54. Class:    Node
  55.  
  56. The Node Class is the base class for the creation of lists.  A node is
  57. basically two pointers, one forward, and one backward (or left and right
  58. in trees).  The Node Class is used by the List Class which manages the
  59. nodes.  Any class derived from the Node Class can be manipulated by
  60. objects in the List Class or classes derived from the List Class.
  61.  
  62. Class:    List
  63.  
  64. The List Class contains methods for operating on lists of Nodes.  This
  65. includes list traversal: forward and backward, inserting and deleting
  66. nodes from the list, and comparison testing for sorting and inserting.
  67. The List Class can be used anywhere a double or single linked list
  68. is required.
  69.  
  70. Class:    Tree (unfinished)
  71.  
  72. The Tree Class utilizes the Node class to build binary tree data structures.
  73. Methods are provided for insertion and deletion, as well as comparison and
  74. sorting of the tree.  The Tree can provide more efficent search and
  75. retrieval as compared to the list, depending on the situation.
  76.  
  77. --------------------------------------------------------------------------
  78. GRAPHICS CATEGORY
  79.  
  80. Class:    Graphic
  81.  
  82. The Graphic Class provides the general interface to the BGI graphics
  83. routines.  The Graphic Class provides a more consistant interface than
  84. the BGI driver.  When a graphics application is ported into another
  85. version of C++ like Zortech C++, the Graphic Class simplifies the
  86. process by providing a common interface.  Only the Graphic Class will
  87. need to be rewritten.  The rest of the graphics code remains the same.
  88.  
  89. Class:    Icon
  90.  
  91. The Icon Class provides a simple way to deal with large numbers of BGI
  92. images.  Icons can be draw on the screen and read directly from the
  93. display screen or loaded and saved in disk files.  There are routines
  94. for creating and drawing masked icons too.
  95.  
  96. Class:    Point
  97.  
  98. The Point Class has methods for working with coordinate data.  Methods
  99. are included for creating and offsetting points.  The operators + and
  100. = can be used to add and copy points.
  101.  
  102. Class:    Rectangle
  103.  
  104. The Rect Class has methods for creating, offsetting, insetting, and
  105. copying rectangles.  The + and = operators provide means for shifting
  106. and copying rectangles.
  107.  
  108. --------------------------------------------------------------------------
  109. EVENT CATEGORY
  110.  
  111. Class:    Event (unfinished)
  112.  
  113. The Event Class provides a means for buffering user input from the
  114. keyboard, mouse, and other input devices.  Methods are provided for
  115. placing new events in the event queue, and for testing and removing
  116. events in the queue.
  117.  
  118. Class:    Mouse
  119.  
  120. The Mouse Class provides a consistent interface to the Microsoft
  121. mouse driver.  Methods are provided for initialization and scaling,
  122. button and position testing.  More than 18 methods including the abilty
  123. to hook into the mouse interrupt.
  124.  
  125. Class:    KeyBrd (unfinished)
  126.  
  127. The KeyBrd Class captures key hits and passes them into the event queue.
  128. This includes keyboard status bits and the keyboard character and
  129. scancode value.
  130.  
  131. --------------------------------------------------------------------------
  132. WINDOW CATEGORY
  133.  
  134. Class:    Window
  135.  
  136. The Window Class is used to create text windows.  Methods are provided
  137. to open and close windows.  A special textbox() method allows you to
  138. print colored text in subwindows on the screen.
  139.  
  140. Class:    Menu
  141.  
  142. The Menu Class creates standard pop-up menus, calling upon the Window
  143. Class to assign a window area on the text screen.  User selection returns
  144. a number representing the menu item position.  The menu is defined by a
  145. simple menu format string.
  146.  
  147. Class:    MenuBar
  148.  
  149. The MenuBar Class is derived from the Menu Class and creates a horizontal
  150. MenuBar instead of a pop-up menu.  It's methods are inherited from the
  151. Menu Class.
  152.  
  153. Class:    Control
  154.  
  155. The Control Class allows the creation of several types of controllers that
  156. can be placed on the text screen.  The most common types are the CheckBox,
  157. the Button, and the text Field.
  158.  
  159. --------------------------------------------------------------------------
  160. SOUND CATEGORY
  161.  
  162. Class:    Sound
  163.  
  164. The Sound Class creates a backgound sound effects and music system, that
  165. will allow music to be produced on the built-in IBM-PC speaker as a
  166. background process while the program continues to run.  New tones are
  167. submitted to a sound buffer as a series of frequency and duration
  168. values.  *Note*  Because the Sound Class creates an interrupt service
  169. routine, only ONE instance of a Sound object should be present in memory
  170. at given time!  The same is true for the Play and Effect Class, because
  171. they are derived from the Sound Class.
  172.  
  173. Class:    Play
  174.  
  175. The Play Class uses the background Sound routines to produce music.  The
  176. music is entered in strings using the text music format common to
  177. Microsoft BASICA and ASCII music notation.  The Play Class tremendously
  178. simplifies the use of the Sound Class because it creates the sound system
  179. automatically.
  180.  
  181. Class:    Effect
  182.  
  183. The Effect Class is a simple sound effects generator that uses the Sound
  184. Class as the basis for operation.  The Effects Class is a small library
  185. of sound effects commonly found in computer games.  The Effect Class is
  186. derived from the Play Class.
  187.  
  188. --------------------------------------------------------------------------
  189. COMMUNICATIONS CATEGORY
  190.  
  191. Class:    Async (unfinished)
  192.  
  193. The Async Class provides buffered communications with the serial ports.
  194.  
  195. --------------------------------------------------------------------------
  196. CLASS.DOC                       Copyright (c) 1991 by James S. Clark
  197. ==========================================================================
  198.